Developer CD Series 1995 June: Reference Library/Dev.CD Jun 95/Dev.CD Jun 95.toast/What's New?/New System Software Extensions/QuickDraw 3D ß/Programming/Interfaces/QD3D.h

C/C++ Source or Header | 1995-04-12 | 30.6 KB | 927 lines | [TEXT/MPS ]

/******************************************************************************
 **                                                                              **
 **     Module:        QD3D.h                                                     **
 **                                                                              **
 **                                                                              **
 **     Purpose:     System include file.                                     **
 **                                                                              **
 **                                                                              **
 **     Copyright (C) 1992-1995 Apple Computer, Inc.  All rights reserved.     **
 **                                                                              **
 **                                                                              **
 *****************************************************************************/
#ifndef QD3D_h
#define QD3D_h

#include <stdio.h>

/******************************************************************************
 **                                                                             **
 **                                Porting Control                                 **
 **                                                                             **
 *****************************************************************************/

#ifndef OS_MACINTOSH

    #define OS_MACINTOSH                1
    #define WINDOW_SYSTEM_MACINTOSH        1

    #if defined(THINK_C) || defined(THINK_CPLUS) || defined(__MWERKS__)
         #define PRAGMA_ONCE                1
    #else
         #define PRAGMA_ONCE                0
    #endif  /*  defined(THINK_C) || defined(THINK_CPLUS) || defined(__MWERKS__)  */

    /*
     * Set required compiler options (if possible):
     *   1. enums must always be ints in QD3D and in applications;
     *      this consistency is required to prevent misinterpretation
     *      of an app's enum values by an API; it is also required for
     *      compliance with ANSI
     *   2. alignment of char and short arrays in structures is not on
     *      long boundaries; (could be other way, but must be consistent
     *      in QD3D and in applications)
     *   3. alignment of longs, floats, and pointers in structures
     *      is on long boundaries for PowerPC
     */
    #if defined(THINK_C) || defined(THINK_CPLUS)
        #pragma options(!pack_enums, !align_arrays)
    #elif defined(__MWERKS__)
        #pragma enumsalwaysint on
        #pragma align_array_members off
        #pragma options align=native
    #elif defined(__PPCC__)
        #pragma options align=power
    #endif

    enum {
        gestaltQD3D                = 'qd3d',
        gestaltQD3DNotPresent    = 0,
        gestaltQD3DAvailable    = 1
    };

#endif  /*  OS_MACINTOSH  */

#if defined(_WIN32) && _WIN32
    #define WINDOW_SYSTEM_WINDOWS        1
#endif  /*  defined(_WIN32) && _WIN32  */

#if defined(PRAGMA_ONCE) && PRAGMA_ONCE
    #pragma once
#endif  /*  PRAGMA_ONCE  */

/*
 *  NOTE:  To compile on a Unix workstation (assumes X11 window system):
 *                1. Add to compiler command line: "-DOS_MACINTOSH=0"
 *                2. Add "-DOS_UNIX=1"
 *                3. Add "-DWINDOW_SYSTEM_X11=1"
 */

/*
 *  NOTE:  To compile on a DOS/WINDOWS machine:
 *                1. Add to compiler command line: "-DOS_MACINTOSH=0"
 *                2. Add "-DOS_WINDOWS=1"
 *                3. Add "-DWINDOW_SYSTEM_WINDOWS=1"
 */


/******************************************************************************
 **                                                                             **
 **                                Export Control                                 **
 **                                                                             **
 *****************************************************************************/

#if defined(_MSC_VER)    /* Microsoft Visual C */
    #define EXPORT        __declspec( dllexport )
#else
    #define EXPORT
#endif  /*  _MSC_VER  */


/******************************************************************************
 **                                                                             **
 **                                NULL definition                                 **
 **                                                                             **
 *****************************************************************************/

#ifndef NULL
#error /*    NULL is undefined?    */
#endif /* NULL */


/******************************************************************************
 **                                                                             **
 **                                    Objects                                     **
 **                                                                             **
 *****************************************************************************/
/*
 * Everything in QuickDraw 3D is an OBJECT: a bunch of data with a type,
 * deletion, duplication, and i/o methods.
 */
typedef long                    TQ3ObjectType;

typedef struct TQ3ObjectPrivate    *TQ3Object;

/*
 * There are four subclasses of OBJECT:
 *    an ELEMENT, which is data that is placed in a SET
 *    a SHAREDOBJECT, which is reference-counted data that is shared
 *    VIEWs, which maintain state information for an image
 *    a PICK, which used to query a VIEW
 */
typedef TQ3Object                TQ3ElementObject;
typedef TQ3Object                TQ3SharedObject;
typedef TQ3Object                TQ3ViewObject;
typedef TQ3Object                TQ3PickObject;

/*
 * There are several types of SharedObjects:
 *    RENDERERs, which paint to a drawContext
 *    DRAWCONTEXTs, which are an interface to a device (not defined here)
 *    SETs, which maintains "mathematical sets" of ELEMENTs
 *    FILEs, which maintain state information for a metafile
 *    REFERENCEs, which contain references to objects in FILEs
 *    SHAPEs, which affect the state of the View
 *    SHAPEPARTs, which contain geometry-specific data about a picking hit
 *    CONTROLLERSTATEs, which hold state of the output channels for a CONTROLLER
 *    TRACKERs, which represent a position and orientation in the user interface
 *  STRINGs, which are abstractions of text string data.
 *    STORAGE, which is an abstraction for stream-based data storage (files, memory)
 *    TEXTUREs, for sharing bitmap information for TEXTURESHADERS
 */
typedef TQ3SharedObject            TQ3RendererObject;
typedef TQ3SharedObject            TQ3DrawContextObject;
typedef TQ3SharedObject            TQ3SetObject;
typedef TQ3SharedObject            TQ3FileObject;
typedef TQ3SharedObject            TQ3ReferenceObject;
typedef TQ3SharedObject            TQ3ShapeObject;
typedef TQ3SharedObject            TQ3ShapePartObject;
typedef TQ3SharedObject            TQ3ControllerStateObject;
typedef TQ3SharedObject            TQ3TrackerObject;
typedef TQ3SharedObject            TQ3StringObject;
typedef TQ3SharedObject            TQ3StorageObject;
typedef TQ3SharedObject            TQ3TextureObject;

#if defined(ESCHER_VER_15) && ESCHER_VER_15
/*
 * (and for QuickDraw 3D 1.5)
 *    COLORSCHEMEs, which determine colors of user interface objects
 *    DEEPBUFFERs, which cache a lot of rasterized information for
 *  deferred interactive imaging.
 *    WIDGETs, for interacting with objects in a view
 *    ATTACHMENTs, for adding parametrizations to geometries
 */
typedef TQ3SharedObject            TQ3ColorSchemeObject;
typedef TQ3SharedObject            TQ3DeepBufferObject;
typedef TQ3SharedObject            TQ3WidgetObject;
typedef TQ3SharedObject            TQ3AttachmentObject;
#endif  /*  ESCHER_VER_15  */

/*
 * There is one type of VIEW:
 *    UIVIEWs, which provide interactive facilities
 */
#if defined(ESCHER_VER_15) && ESCHER_VER_15
typedef TQ3ViewObject            TQ3UIViewObject;
#endif  /*  ESCHER_VER_15  */

/*
 * There is one types of SET:
 *    ATTRIBUTESETs, which contain ATTRIBUTEs which are inherited and interpolated
 */
typedef TQ3SetObject                TQ3AttributeSet;

/*
 * There are many types of SHAPEs:
 *    LIGHTs, which affect how the RENDERER draws 3-D cues
 *    CAMERAs, which affects the location and orientation of the RENDERER in space
 *    GROUPs, which may contain any number of SHARED OBJECTS
 *    GEOMETRYs, which are representations of three-dimensional data
 *    SHADERs, which affect how colors are drawn on a geometry
 *    STYLEs, which affect how the RENDERER paints to the DRAWCONTEXT
 *    TRANSFORMs, which affect the coordinate system in the VIEW
 *  UNKNOWN, which hold unknown objects read from a metafile.
 */
typedef TQ3ShapeObject            TQ3GroupObject;
typedef TQ3ShapeObject            TQ3GeometryObject;
typedef TQ3ShapeObject            TQ3ShaderObject;
typedef TQ3ShapeObject            TQ3StyleObject;
typedef TQ3ShapeObject            TQ3TransformObject;
typedef TQ3ShapeObject            TQ3LightObject;
typedef TQ3ShapeObject            TQ3CameraObject;
typedef TQ3ShapeObject            TQ3UnknownObject;

/*
 * For now, there is only one type of SHAPEPARTs:
 *    MESHPARTs, which describe some part of a mesh
 */
typedef TQ3ShapePartObject        TQ3MeshPartObject;

/*
 * There are three types of MESHPARTs:
 *    MESHFACEPARTs, which describe a face of a mesh
 *    MESHEDGEPARTs, which describe a edge of a mesh
 *    MESHVERTEXPARTs, which describe a vertex of a mesh
 */
typedef TQ3MeshPartObject        TQ3MeshFacePartObject;
typedef TQ3MeshPartObject        TQ3MeshEdgePartObject;
typedef TQ3MeshPartObject        TQ3MeshVertexPartObject;

/*
 * A DISPLAY Group can be drawn to a view
 */
typedef TQ3GroupObject            TQ3DisplayGroupObject;

/*
 * There are many types of SHADERs:
 *    SURFACESHADERs, which affect how the surface of a geometry is painted
 *    ILLUMINATIONSHADERs, which affect how lights affect the color of a surface
 */
typedef TQ3ShaderObject            TQ3SurfaceShaderObject;
typedef TQ3ShaderObject            TQ3IlluminationShaderObject;

/*
 * A handle to an object in a group
 */
typedef struct TQ3GroupPositionPrivate    *TQ3GroupPosition;


/******************************************************************************
 **                                                                             **
 **                            Client/Server Things                             **
 **                                                                             **
 *****************************************************************************/

typedef void *TQ3ControllerRef;


/******************************************************************************
 **                                                                             **
 **                            Flags and Switches                                 **
 **                                                                             **
 *****************************************************************************/

typedef enum TQ3Boolean {
    kQ3False,
    kQ3True
} TQ3Boolean;

typedef enum TQ3Switch {
    kQ3Off,
    kQ3On
} TQ3Switch;

typedef enum TQ3Status {
    kQ3Failure,
    kQ3Success
} TQ3Status;

typedef enum TQ3SideMasks {
    kQ3SideNone            = 0,
    kQ3SideMaskFront    = 1 << 0,
    kQ3SideMaskBack        = 1 << 1
} TQ3SideMasks;

typedef unsigned long TQ3Side;

typedef enum TQ3Axis {
    kQ3AxisX,
    kQ3AxisY,
    kQ3AxisZ
} TQ3Axis;

typedef enum TQ3PixelType {
    kQ3PixelTypeRGB32,
    kQ3PixelTypeRGB24,
    kQ3PixelTypeRGB16,
    kQ3PixelTypeRGB8
} TQ3PixelType;

typedef enum TQ3Endian{
    kQ3EndianBig,
    kQ3EndianLittle
} TQ3Endian;

typedef enum TQ3EndCapMasks {
    kQ3EndCapNone            = 0,
    kQ3EndCapMaskTop        = 1 << 0,
    kQ3EndCapMaskBottom        = 1 << 1
} TQ3EndCapMasks;

typedef unsigned long TQ3EndCap;


/******************************************************************************
 **                                                                             **
 **                        Point and Vector Definitions                         **
 **                                                                             **
 *****************************************************************************/

typedef struct TQ3Vector2D {
    float        x;
    float        y;
} TQ3Vector2D;

typedef struct TQ3Vector3D {
    float         x;
    float        y;
    float        z;
} TQ3Vector3D;

typedef struct TQ3Point2D {
    float        x;
    float        y;
} TQ3Point2D;

typedef struct TQ3Point3D {
    float         x;
    float        y;
    float        z;
} TQ3Point3D;

typedef struct TQ3RationalPoint4D {
    float         x;
    float        y;
    float        z;
    float        w;
} TQ3RationalPoint4D;

typedef struct TQ3RationalPoint3D {
    float        x;
    float        y;
    float        w;
} TQ3RationalPoint3D;


/******************************************************************************
 **                                                                             **
 **                                Quaternion                                     **
 **                                                                             **
 *****************************************************************************/

typedef struct TQ3Quaternion {
    float        w;
    float        x;
    float        y;
    float        z;
} TQ3Quaternion;


/******************************************************************************
 **                                                                             **
 **                                Ray Definition                                 **
 **                                                                             **
 *****************************************************************************/

typedef struct TQ3Ray3D {
    TQ3Point3D        origin;
    TQ3Vector3D        direction;
} TQ3Ray3D;


/******************************************************************************
 **                                                                             **
 **                        Parameterization Data Structures                     **
 **                                                                             **
 *****************************************************************************/

typedef struct TQ3Param2D {
    float            u;
    float            v;
} TQ3Param2D;

typedef struct TQ3Param3D {
    float            u;
    float            v;
    float            w;
} TQ3Param3D;

typedef struct TQ3Tangent2D {
    TQ3Vector3D        uTangent;
    TQ3Vector3D        vTangent;
} TQ3Tangent2D;

typedef struct TQ3Tangent3D {
    TQ3Vector3D        uTangent;
    TQ3Vector3D        vTangent;
    TQ3Vector3D        wTangent;
} TQ3Tangent3D;


/******************************************************************************
 **                                                                             **
 **                        Polar and Spherical Coordinates                         **
 **                                                                             **
 *****************************************************************************/

 typedef struct TQ3PolarPoint {
     float        r;
     float        theta;
  } TQ3PolarPoint;

 typedef struct TQ3SphericalPoint {
     float        rho;
     float        theta;
     float        phi;
 } TQ3SphericalPoint;


/******************************************************************************
 **                                                                             **
 **                            Color Definition                                 **
 **                                                                             **
 *****************************************************************************/

typedef struct TQ3ColorRGB {
    float             r;
    float            g;
    float            b;
} TQ3ColorRGB;


typedef struct TQ3ColorARGB {
    float             a;
    float             r;
    float            g;
    float            b;
} TQ3ColorARGB;

/******************************************************************************
 **                                                                             **
 **                                    Vertices                                 **
 **                                                                             **
 *****************************************************************************/

typedef struct TQ3Vertex3D {
    TQ3Point3D            point;
    TQ3AttributeSet        attributeSet;
}  TQ3Vertex3D;


/******************************************************************************
 **                                                                             **
 **                                    Matrices                                 **
 **                                                                             **
 *****************************************************************************/

typedef struct TQ3Matrix3x3 {
    float    value[3][3];
} TQ3Matrix3x3;

typedef struct TQ3Matrix4x4 {
    float    value[4][4];
} TQ3Matrix4x4;


/******************************************************************************
 **                                                                             **
 **                                Bitmap/Pixmap                                 **
 **                                                                             **
 *****************************************************************************/

typedef struct TQ3Pixmap {
    void                *image;
    unsigned long        width;
    unsigned long        height;
    unsigned long        rowBytes;
    unsigned long        pixelSize;
    TQ3PixelType        pixelType;
    TQ3Endian            bitOrder;
    TQ3Endian            byteOrder;
} TQ3Pixmap;

typedef struct TQ3StoragePixmap {
    TQ3StorageObject    image;
    unsigned long        width;
    unsigned long        height;
    unsigned long        rowBytes;
    unsigned long        pixelSize;
    TQ3PixelType        pixelType;
    TQ3Endian            bitOrder;
    TQ3Endian            byteOrder;
} TQ3StoragePixmap;

typedef struct TQ3Bitmap {
    unsigned char        *image;
    unsigned long        width;
    unsigned long        height;
    unsigned long        rowBytes;
    TQ3Endian            bitOrder;
} TQ3Bitmap;


#ifdef __cplusplus
extern "C" {
#endif    /* __cplusplus */


EXPORT TQ3Status Q3Bitmap_Empty(
    TQ3Bitmap            *bitmap);

EXPORT unsigned long Q3Bitmap_GetImageSize(
    unsigned long        width,
    unsigned long        height);


#ifdef __cplusplus
}
#endif    /* __cplusplus */


/******************************************************************************
 **                                                                             **
 **                        Higher dimension quantities                             **
 **                                                                             **
 *****************************************************************************/

typedef struct TQ3Area {
    TQ3Point2D             min;
    TQ3Point2D             max;
} TQ3Area;

typedef struct TQ3PlaneEquation {
    TQ3Vector3D            normal;
    float                constant;
} TQ3PlaneEquation;

typedef struct TQ3BoundingBox {
    TQ3Point3D             min;
    TQ3Point3D             max;
    TQ3Boolean            isEmpty;
} TQ3BoundingBox;

typedef struct TQ3BoundingSphere {
    TQ3Point3D            origin;
    float                radius;
    TQ3Boolean            isEmpty;
} TQ3BoundingSphere;

/*
 *    The TQ3ComputeBounds flag passed to BoundingBox or BoundingSphere
 *    calls is a hint to the system as to how it should
 *    compute the bbox of a shape:
 *
 *    kQ3ComputeBoundsExact:
 *        Vertices of shapes are transformed into world space and
 *        the world space bounding box is computed from them.  Slow!
 *
 *    kQ3ComputeBoundsApproximate:
 *        A local space bounding box is computed from a shape's
 *        vertices.  This bbox is then transformed into world space,
 *        and its bounding box is taken as the shape's approximate
 *        bbox.  Fast but the bbox is larger than optimal.
 */

typedef enum TQ3ComputeBounds {
    kQ3ComputeBoundsExact,
    kQ3ComputeBoundsApproximate
} TQ3ComputeBounds;


/******************************************************************************
 **                                                                             **
 **                            Object System Types                                 **
 **                                                                             **
 *****************************************************************************/

typedef struct TQ3ObjectClassPrivate        *TQ3ObjectClass;

typedef unsigned long                         TQ3MethodType;

/*
 * Object methods
 */
#define kQ3MethodTypeObjectDuplicate        Q3_METHOD_TYPE('d','u','p','l')
#define kQ3MethodTypeObjectDelete            Q3_METHOD_TYPE('d','l','t','e')
#define kQ3MethodTypeObjectUnregister        Q3_METHOD_TYPE('u','n','r','g')
#define kQ3MethodTypeObjectDraw                Q3_METHOD_TYPE('d','r','a','w')

/*
 * IO Methods
 */
#define kQ3MethodTypeObjectFileVersion        Q3_METHOD_TYPE('v','e','r','s') /* version */

#define kQ3MethodTypeObjectTraverse            Q3_METHOD_TYPE('t','r','v','s') /* byte count */
#define kQ3MethodTypeObjectWrite            Q3_METHOD_TYPE('w','r','i','t') /* Dump info to file */
#define kQ3MethodTypeObjectRead                Q3_METHOD_TYPE('r','e','a','d') /* Read info from file, create object */
#define kQ3MethodTypeObjectReadData            Q3_METHOD_TYPE('r','d','d','t') /* Read info from file into buffer or, attach read data to parent */
#define kQ3MethodTypeObjectAttach            Q3_METHOD_TYPE('a','t','t','c') /* Attach one read object to another */

typedef void (*TQ3FunctionPointer)(
    void);

typedef TQ3FunctionPointer (*TQ3MetaHandler)(
    TQ3MethodType        methodType);

/*
 * MetaHandler:
 *        When you give a metahandler to QuickDraw 3D, it is called multiple times to
 *        build method tables, and then is thrown away. You are guaranteed that
 *        your metahandler will never be called again after a call that was passed
 *        a metahandler returns.
 *
 *        Your metahandler should contain a switch on the methodType passed to it
 *        and should return the corresponding method as an TQ3FunctionPointer.
 *
 *        IMPORTANT: A metaHandler MUST always "return" a value. If you are
 *        passed a methodType that you do not understand, ALWAYS return NULL.
 *
 *        These types here are prototypes of how your functions should look.
 */

typedef TQ3Status (*TQ3ObjectDeleteMethod)(
    TQ3Object            object);

typedef TQ3Object (*TQ3ObjectDuplicateMethod)(
    TQ3Object            object);

typedef TQ3Status (*TQ3ObjectUnregisterMethod)(
    TQ3ObjectClass        objectClass);

typedef TQ3Status (*TQ3ObjectDrawMethod)(
    TQ3Object            object,
    TQ3ViewObject        view);

/*
 * See QD3DIO.h for the IO method types:
 *        ObjectRead, ObjectReadData, ObjectAttach, ObjectTraverse, ObjectWrite
 */

/******************************************************************************
 **                                                                             **
 **                            Object System Macros                             **
 **                                                                             **
 *****************************************************************************/

#define Q3_FOUR_CHARACTER_CONSTANT(a,b,c,d)         \
            ((const unsigned long)                     \
            ((const unsigned long) (a) << 24) |     \
            ((const unsigned long) (b) << 16) |        \
            ((const unsigned long) (c) << 8)  |     \
            ((const unsigned long) (d)))

#define Q3_OBJECT_TYPE(a,b,c,d) ((TQ3ObjectType) Q3_FOUR_CHARACTER_CONSTANT(a,b,c,d))
#define Q3_METHOD_TYPE(a,b,c,d) ((TQ3MethodType) Q3_FOUR_CHARACTER_CONSTANT(a,b,c,d))


/******************************************************************************
 **                                                                             **
 **                                Object Types                                 **
 **                                                                             **
 *****************************************************************************/

/*
 * Note:    a call to Q3Foo_GetType will return a value kQ3FooTypeBar
 *            e.g. Q3Shared_GetType(janeObject) returns kQ3SharedTypeShape, etc.
 */
#define kQ3ObjectTypeInvalid                            0
#define kQ3ObjectTypeView                                Q3_OBJECT_TYPE('v','i','e','w')
    #if defined(ESCHER_VER_15) && ESCHER_VER_15
    #define kQ3ViewTypeUIView                            Q3_OBJECT_TYPE('u','i','v','w')
    #endif  /*  ESCHER_VER_15  */
#define kQ3ObjectTypeElement                            Q3_OBJECT_TYPE('e','l','m','n')
    #define kQ3ElementTypeAttribute                        Q3_OBJECT_TYPE('e','a','t','t')
#define kQ3ObjectTypePick                                Q3_OBJECT_TYPE('p','i','c','k')
    #define kQ3PickTypeWindowPoint                        Q3_OBJECT_TYPE('p','k','w','p')
    #define kQ3PickTypeWindowRect                        Q3_OBJECT_TYPE('p','k','w','r')
    #if defined(ESCHER_VER_15) && ESCHER_VER_15
    #define kQ3PickTypeBox                                Q3_OBJECT_TYPE('p','k','b','x')
    #define kQ3PickTypeRay                                Q3_OBJECT_TYPE('p','k','r','y')
    #define kQ3PickTypeSphere                            Q3_OBJECT_TYPE('p','k','s','p')
    #endif  /*  ESCHER_VER_15  */
#define kQ3ObjectTypeShared                                Q3_OBJECT_TYPE('s','h','r','d')
    #define kQ3SharedTypeRenderer                        Q3_OBJECT_TYPE('r','d','d','r')
        #define kQ3RendererTypeWireFrame                Q3_OBJECT_TYPE('w','r','f','r')
        #if defined(ESCHER_VER_15) && ESCHER_VER_15
        #define kQ3RendererTypeZBuffer                    Q3_OBJECT_TYPE('z','b','u','f')
        #endif
        #define kQ3RendererTypeGeneric                    Q3_OBJECT_TYPE('g','n','r','r')
        #define kQ3RendererTypeEmpty                    Q3_OBJECT_TYPE('e','m','t','r')
        #define kQ3RendererTypeInteractive                Q3_OBJECT_TYPE('c','t','w','n')
    #define kQ3SharedTypeShape                            Q3_OBJECT_TYPE('s','h','a','p')
        #define kQ3ShapeTypeGeometry                    Q3_OBJECT_TYPE('g','m','t','r')
            #define kQ3GeometryTypeBox                    Q3_OBJECT_TYPE('b','o','x',' ')
            #define kQ3GeometryTypeGeneralPolygon        Q3_OBJECT_TYPE('g','p','g','n')
            #define kQ3GeometryTypeLine                    Q3_OBJECT_TYPE('l','i','n','e')
            #define kQ3GeometryTypeMarker                Q3_OBJECT_TYPE('m','r','k','r')
            #define kQ3GeometryTypeMesh                    Q3_OBJECT_TYPE('m','e','s','h')
            #define kQ3GeometryTypeNURBCurve            Q3_OBJECT_TYPE('n','r','b','c')
            #define kQ3GeometryTypeNURBPatch            Q3_OBJECT_TYPE('n','r','b','p')
            #define kQ3GeometryTypePoint                Q3_OBJECT_TYPE('p','n','t',' ')
            #define kQ3GeometryTypePolygon                Q3_OBJECT_TYPE('p','l','y','g')
            #define kQ3GeometryTypeTriangle                Q3_OBJECT_TYPE('t','r','n','g')
            #define kQ3GeometryTypeTriGrid                Q3_OBJECT_TYPE('t','r','i','g')
            #if defined(ESCHER_VER_15) && ESCHER_VER_15
            #define kQ3GeometryTypeCone                    Q3_OBJECT_TYPE('c','o','n','e')
            #define kQ3GeometryTypeCylinder                Q3_OBJECT_TYPE('c','y','l','n')
            #define kQ3GeometryTypeDisk                    Q3_OBJECT_TYPE('d','i','s','k')
            #define kQ3GeometryTypeEllipse                Q3_OBJECT_TYPE('e','l','p','s')
            #define kQ3GeometryTypeEllipsoid            Q3_OBJECT_TYPE('e','l','p','d')
            #define kQ3GeometryTypePolyLine                Q3_OBJECT_TYPE('p','l','y','l')
            #define kQ3GeometryTypeTorus                Q3_OBJECT_TYPE('t','o','r','s')
            #endif  /*  ESCHER_VER_15  */
        #define kQ3ShapeTypeShader                        Q3_OBJECT_TYPE('s','h','d','r')
            #define kQ3ShaderTypeSurface                Q3_OBJECT_TYPE('s','u','s','h')
                #define kQ3SurfaceShaderTypeTexture        Q3_OBJECT_TYPE('t','x','s','u')
            #define kQ3ShaderTypeIllumination            Q3_OBJECT_TYPE('i','l','s','h')
                #define kQ3IlluminationTypePhong        Q3_OBJECT_TYPE('p','h','i','l')
                #define kQ3IlluminationTypeLambert        Q3_OBJECT_TYPE('l','m','i','l')
                #define kQ3IlluminationTypeNULL            Q3_OBJECT_TYPE('n','u','i','l')
            #if defined(ESCHER_VER_15) && ESCHER_VER_15
            #define kQ3ShaderTypeImage                    Q3_OBJECT_TYPE('i','m','s','h')
            #define kQ3ShaderTypeTrim                    Q3_OBJECT_TYPE('t','r','s','h')
            #define kQ3ShaderTypeAtmospheric            Q3_OBJECT_TYPE('a','t','s','h')
            #endif  /*  ESCHER_VER_15  */
        #define kQ3ShapeTypeStyle                        Q3_OBJECT_TYPE('s','t','y','l')
            #define kQ3StyleTypeBackfacing                Q3_OBJECT_TYPE('b','c','k','f')
            #define kQ3StyleTypeInterpolation            Q3_OBJECT_TYPE('i','n','t','p')
            #define kQ3StyleTypeFill                    Q3_OBJECT_TYPE('f','i','s','t')
            #define kQ3StyleTypePickID                    Q3_OBJECT_TYPE('p','k','i','d')
            #define kQ3StyleTypeReceiveShadows            Q3_OBJECT_TYPE('r','c','s','h')
            #define kQ3StyleTypeHighlight                Q3_OBJECT_TYPE('h','i','g','h')
            #define kQ3StyleTypeSubdivision                Q3_OBJECT_TYPE('s','b','d','v')
            #define kQ3StyleTypeOrientation                Q3_OBJECT_TYPE('o','f','d','r')
            #define kQ3StyleTypePickParts                Q3_OBJECT_TYPE('p','k','p','t')
        #define kQ3ShapeTypeTransform                    Q3_OBJECT_TYPE('x','f','r','m')
            #define kQ3TransformTypeMatrix                Q3_OBJECT_TYPE('m','t','r','x')
            #define kQ3TransformTypeScale                Q3_OBJECT_TYPE('s','c','a','l')
            #define kQ3TransformTypeTranslate            Q3_OBJECT_TYPE('t','r','n','s')
            #define kQ3TransformTypeRotate                Q3_OBJECT_TYPE('r','o','t','t')
            #define kQ3TransformTypeRotateAboutPoint     Q3_OBJECT_TYPE('r','t','a','p')
            #define kQ3TransformTypeRotateAboutAxis     Q3_OBJECT_TYPE('r','t','a','a')
            #define kQ3TransformTypeQuaternion            Q3_OBJECT_TYPE('q','t','r','n')
        #define kQ3ShapeTypeLight                        Q3_OBJECT_TYPE('l','g','h','t')
            #define kQ3LightTypeAmbient                    Q3_OBJECT_TYPE('a','m','b','n')
            #define kQ3LightTypeDirectional                Q3_OBJECT_TYPE('d','r','c','t')
            #define kQ3LightTypePoint                    Q3_OBJECT_TYPE('p','n','t','l')
            #define kQ3LightTypeSpot                    Q3_OBJECT_TYPE('s','p','o','t')
        #define kQ3ShapeTypeCamera                        Q3_OBJECT_TYPE('c','m','r','a')
            #define kQ3CameraTypeOrthographic            Q3_OBJECT_TYPE('o','r','t','h')
            #define kQ3CameraTypeViewPlane                Q3_OBJECT_TYPE('v','w','p','l')
            #define kQ3CameraTypeViewAngleAspect        Q3_OBJECT_TYPE('v','a','n','a')
        #define kQ3ShapeTypeGroup                        Q3_OBJECT_TYPE('g','r','u','p')
            #define kQ3GroupTypeDisplay                    Q3_OBJECT_TYPE('d','s','p','g')
                #define kQ3DisplayGroupTypeOrdered        Q3_OBJECT_TYPE('o','r','d','g')
                #define kQ3DisplayGroupTypeIOProxy        Q3_OBJECT_TYPE('i','o','p','x')
            #define kQ3GroupTypeLight                    Q3_OBJECT_TYPE('l','g','h','g')
            #define kQ3GroupTypeInfo                    Q3_OBJECT_TYPE('i','n','f','o')
        #define kQ3ShapeTypeUnknown                        Q3_OBJECT_TYPE('u','n','k','n')
            #define kQ3UnknownTypeText                        Q3_OBJECT_TYPE('u','k','t','x')
            #define kQ3UnknownTypeBinary                    Q3_OBJECT_TYPE('u','k','b','n')
    #define kQ3SharedTypeSet                            Q3_OBJECT_TYPE('s','e','t',' ')
        #define kQ3SetTypeAttribute                        Q3_OBJECT_TYPE('a','t','t','r')
    #define kQ3SharedTypeDrawContext                    Q3_OBJECT_TYPE('d','c','t','x')
        #define kQ3DrawContextTypePixmap                Q3_OBJECT_TYPE('d','p','x','p')
        #define kQ3DrawContextTypeMacintosh                Q3_OBJECT_TYPE('d','m','a','c')
        #if defined(ESCHER_VER_15) && ESCHER_VER_15
        #define kQ3DrawContextTypeWindows                Q3_OBJECT_TYPE('d','w','i','n')
        #define kQ3DrawContextTypeX11                    Q3_OBJECT_TYPE('d','x','1','1')
        #define kQ3DrawContextTypeFile                    Q3_OBJECT_TYPE('d','f','i','l')
        #endif  /*  ESCHER_VER_15  */
    #define kQ3SharedTypeTexture                        Q3_OBJECT_TYPE('t','x','t','r')
        #define kQ3TextureTypePixmap                    Q3_OBJECT_TYPE('t','x','p','m')
        #if defined(ESCHER_VER_15) && ESCHER_VER_15
        #define kQ3TextureTypeQuickdrawGX                Q3_OBJECT_TYPE('t','x','g','x')
        #endif  /*  ESCHER_VER_15  */
    #if defined(ESCHER_VER_15) && ESCHER_VER_15
    #define kQ3SharedTypeAttachment                        Q3_OBJECT_TYPE('a','t','c','h')
    #endif  /*  ESCHER_VER_15  */
    #define kQ3SharedTypeFile                            Q3_OBJECT_TYPE('f','i','l','e')
    #define kQ3SharedTypeStorage                        Q3_OBJECT_TYPE('s','t','r','g')
        #define kQ3StorageTypeMemory                    Q3_OBJECT_TYPE('m','e','m','s')
            #define kQ3MemoryStorageTypeHandle            Q3_OBJECT_TYPE('h','n','d','l')
        #define kQ3StorageTypeUnix                        Q3_OBJECT_TYPE('u','x','s','t')
            #define kQ3UnixStorageTypePath                Q3_OBJECT_TYPE('u','n','i','x')
        #define kQ3StorageTypeMacintosh                    Q3_OBJECT_TYPE('m','a','c','n')
            #define kQ3MacintoshStorageTypeFSSpec        Q3_OBJECT_TYPE('m','a','c','p')
    #define kQ3SharedTypeReference                        Q3_OBJECT_TYPE('r','f','r','n')
    #define kQ3SharedTypeString                            Q3_OBJECT_TYPE('s','t','r','n')
        #define kQ3StringTypeCString                    Q3_OBJECT_TYPE('s','t','r','c')
        #if defined(ESCHER_VER_15) && ESCHER_VER_15
        #define kQ3StringTypeUnicode                    Q3_OBJECT_TYPE('u','n','c','d')
        #define kQ3StringTypeWorldScript                Q3_OBJECT_TYPE('s','c','r','p')
        #endif  /*  ESCHER_VER_15  */
    #define kQ3SharedTypeShapePart                        Q3_OBJECT_TYPE('s','p','r','t')
        #define kQ3ShapePartTypeMeshPart                Q3_OBJECT_TYPE('s','p','m','h')
            #define kQ3MeshPartTypeMeshFacePart            Q3_OBJECT_TYPE('m','f','a','c')
            #define kQ3MeshPartTypeMeshEdgePart            Q3_OBJECT_TYPE('m','e','d','g')
            #define kQ3MeshPartTypeMeshVertexPart        Q3_OBJECT_TYPE('m','v','t','x')
    #define kQ3SharedTypeControllerState                Q3_OBJECT_TYPE('c','t','s','t')
    #define kQ3SharedTypeTracker                        Q3_OBJECT_TYPE('t','r','k','r')
    #define kQ3SharedTypeViewHints                        Q3_OBJECT_TYPE('v','w','h','n')
    #define kQ3SharedTypeDrawContextHints                Q3_OBJECT_TYPE('d','c','h','n')
    #if defined(ESCHER_VER_15) && ESCHER_VER_15
    #define kQ3SharedTypeDeepBuffer                        Q3_OBJECT_TYPE('d','e','e','p')
    #define kQ3SharedTypeWidget                            Q3_OBJECT_TYPE('w','d','g','t')
    #define kQ3SharedTypeColorScheme                    Q3_OBJECT_TYPE('c','s','c','h')
    #endif  /*  ESCHER_VER_15  */


#ifdef __cplusplus
extern "C" {
#endif    /* __cplusplus */

/******************************************************************************
 **                                                                             **
 **                            QuickDraw 3D System Routines                     **
 **                                                                             **
 *****************************************************************************/

EXPORT TQ3Status Q3Initialize(
    void);

EXPORT TQ3Status Q3Exit(
    void);

EXPORT TQ3Boolean Q3IsInitialized(
    void);

EXPORT TQ3Status Q3GetVersion(
    unsigned long        *majorRevision,
    unsigned long        *minorRevision);


/******************************************************************************
 **                                                                             **
 **                            ObjectClass Routines                             **
 **                                                                             **
 *****************************************************************************/

EXPORT TQ3Status Q3ObjectClass_Unregister(
    TQ3ObjectClass        objectClass);


/******************************************************************************
 **                                                                             **
 **                                Object Routines                                 **
 **                                                                             **
 *****************************************************************************/

EXPORT TQ3Status Q3Object_Dispose(
    TQ3Object             object);

EXPORT TQ3Object Q3Object_Duplicate(
    TQ3Object            object);

EXPORT TQ3Status Q3Object_Submit(
    TQ3Object            object,
    TQ3ViewObject        view);

EXPORT TQ3Boolean Q3Object_IsDrawable(
    TQ3Object            object);


/******************************************************************************
 **                                                                             **
 **                            Object Type Routines                             **
 **                                                                             **
 *****************************************************************************/

EXPORT TQ3ObjectType Q3Object_GetType(
    TQ3Object            object);

EXPORT TQ3ObjectType Q3Object_GetLeafType(
    TQ3Object            object);

EXPORT TQ3Boolean Q3Object_IsType(
    TQ3Object            object,
    TQ3ObjectType        type);


/******************************************************************************
 **                                                                             **
 **                            Shared Object Routines                             **
 **                                                                             **
 *****************************************************************************/

EXPORT TQ3ObjectType Q3Shared_GetType(
    TQ3SharedObject     sharedObject);

EXPORT TQ3SharedObject Q3Shared_GetReference(
    TQ3SharedObject     sharedObject);


/******************************************************************************
 **                                                                             **
 **                                Shape Routines                                 **
 **                                                                             **
 *****************************************************************************/

EXPORT TQ3ObjectType Q3Shape_GetType(
    TQ3ShapeObject    shape);

EXPORT TQ3Status Q3Shape_GetSet(
    TQ3ShapeObject    shape,
    TQ3SetObject    *set);

EXPORT TQ3Status Q3Shape_SetSet(
    TQ3ShapeObject    shape,
    TQ3SetObject     set);


#ifdef __cplusplus
}
#endif  /*  __cplusplus  */

#endif /*  QD3D_h  */